IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/librw/RWvostream.z/RWvostream

Text File | 2002-10-03 | 14.3 KB | 397 lines

RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))                                              RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))



NNNNaaaammmmeeee
     RWvostream - Rogue Wave library class

SSSSyyyynnnnooooppppssssiiiissss
              #include <rw/vstream.h>







DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
     Class RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm is an abstract base class.  It provides an interface for
     format-independent storage of fundamental types and arrays of fundamental
     types.  Its counterpart, RRRRWWWWvvvviiiissssttttrrrreeeeaaaammmm, provides a complementary interface
     for the retrieval of variables of the fundamental types. Because the
     interface of RRRRWWWWvvvviiiissssttttrrrreeeeaaaammmm and RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm is independent of formatting, the
     user of these classes need not be concerned with how variables will
     actually be stored or restored.  That will be up to the derived class to
     decide.  It might be done using an operating-system independent ASCII
     format (classes RRRRWWWWppppiiiissssttttrrrreeeeaaaammmm and RRRRWWWWppppoooossssttttrrrreeeeaaaammmm), a binary format (classes
     RRRRWWWWbbbbiiiissssttttrrrreeeeaaaammmm and RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm), or the user could define his or her own
     format (eeee....gggg...., an interface to a network).  Note that because it is an
     aaaabbbbssssttttrrrraaaacccctttt base class, there is no way to actually enforce these goals --
     the description here is merely the model of how a class derived from
     RRRRWWWWvvvviiiissssttttrrrreeeeaaaammmm and RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm should act.  NNNNooootttteeee tttthhhhaaaatttt tttthhhheeeerrrreeee iiiissss nnnnoooo nnnneeeeeeeedddd ttttoooo
     sssseeeeppppaaaarrrraaaatttteeee vvvvaaaarrrriiiiaaaabbbblllleeeessss wwwwiiiitttthhhh wwwwhhhhiiiitttteeeessssppppaaaacccceeee.  It is the responsibility of the
     derived class to delineate variables with whitespace, packet breaks, or
     whatever might be appropriate for the final output sink.  The model is
     one where variables are inserted into the output stream, either
     individually or as homogeneous vectors, to be restored in the same order
     using RRRRWWWWvvvviiiissssttttrrrreeeeaaaammmm.  Storage and retrieval of characters requires some
     explanation.  Characters can be thought of as either representing some
     alphanumeric or control character, or as the literal number.  Generally,
     the overloaded insertion (<<) and extraction (>>) operators seek to store
     and restore characters preserving their symbolic meaning.  That is,
     storage of a newline should be restored as a newline, regardless of its
     representation on the target machine.  By contrast, member functions
     ggggeeeetttt(((()))) and ppppuuuutttt(((()))) should treat the character as a literal number, whose
     value is to be preserved.  See also class RRRRWWWWppppoooossssttttrrrreeeeaaaammmm.

PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
     None

EEEExxxxaaaammmmpppplllleeee
              #include <rw/vstream.h>








                                                                        PPPPaaaaggggeeee 1111






RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))                                              RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))



              void storeStuff( RWvostream& str) {
             int i = 5;
             double d = 22.5;
             char string[] = "A string with  tabs and a newline0;
             str << i;        // Store an int
             str << d;        // Store a double
             str << string;   // Store a string
             if(str.fail()) cerr << "Oh, oh, bad news.0;
          }

PPPPuuuubbbblllliiiicccc DDDDeeeessssttttrrrruuuuccccttttoooorrrr
              virtual ~~~~RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm(((())));






     This virtual destructor allows specializing classes to deallocate any
     resources that they may have allocated.

PPPPuuuubbbblllliiiicccc OOOOppppeeeerrrraaaattttoooorrrrssss
              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(const char* s) = 0;


     Store the character string starting at ssss to the output stream.  The
     character string is expected to be null terminated.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(const wchar_t* ws) = 0;


     Store the wide character string starting at wwwwssss to the output stream.  The
     character string is expected to be null terminated.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(char c) = 0;


     Store the cccchhhhaaaarrrr cccc to the output stream.  Note that cccc is treated as a
     character, not a number.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(wchar_t wc) = 0;


     Store the wwwwcccchhhhaaaarrrr____tttt wwwwcccc to the output stream.  Note that wwwwcccc is treated as a
     character, not a number.






                                                                        PPPPaaaaggggeeee 2222






RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))                                              RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))



              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(unsigned char c) = 0;


     Store the uuuunnnnssssiiiiggggnnnneeeedddd cccchhhhaaaarrrr cccc to the output stream.  Note that cccc is treated
     as a character, not a number.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(double d) = 0;


     Store the ddddoooouuuubbbblllleeee dddd to the output stream.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(float f) = 0;


     Store the ffffllllooooaaaatttt ffff to the output stream.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(int i) = 0;


     Store the iiiinnnntttt iiii to the output stream.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(unsigned int i) = 0;


     Store the uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt iiii to the output stream.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(long l) = 0;


     Store the lllloooonnnngggg llll to the output stream.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(unsigned long l) = 0;


     Store the uuuunnnnssssiiiiggggnnnneeeedddd lllloooonnnngggg llll to the output stream.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(short s) = 0;


     Store the sssshhhhoooorrrrtttt ssss to the output stream.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(unsigned short s) = 0;




                                                                        PPPPaaaaggggeeee 3333






RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))                                              RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))



     Store the uuuunnnnssssiiiiggggnnnneeeedddd sssshhhhoooorrrrtttt ssss to the output stream.

              ooooppppeeeerrrraaaattttoooorrrr vvvvooooiiiidddd****();


     Inherited from RRRRWWWWvvvviiiioooossss.

PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
              virtual RWvostream&
          fffflllluuuusssshhhh();


     Send the contents of the stream buffer to output immediately.

              virtual RWvostream&
          ppppuuuutttt(char c) = 0;


     Store the cccchhhhaaaarrrr cccc to the output stream, preserving its value.

              virtual RWvostream&
          ppppuuuutttt(wchar_t wc) = 0;


     Store the wwwwcccchhhhaaaarrrr____tttt wwwwcccc to the output stream, preserving its value.

              virtual RWvostream&
          ppppuuuutttt(unsigned char c) = 0;


     Store the cccchhhhaaaarrrr cccc to the output stream, preserving its value.

              virtual RWvostream&
          ppppuuuutttt(const char* p, size_t N) = 0;


     Store the vector of NNNN cccchhhhaaaarrrrs starting at pppp to the output stream.  The
     chars should be treated as literal numbers (iiii....eeee...., not as a character
     string).

              virtual RWvostream&
          ppppuuuutttt(const wchar_t* p, size_t N) = 0;


     Store the vector of NNNN wwwwcccchhhhaaaarrrr____tttts starting at pppp to the output stream.  The
     chars should be treated as literal numbers (iiii....eeee...., not as a character
     string).

              virtual RWvostream&
          ppppuuuutttt(const unsigned char* p, size_t N) = 0;





                                                                        PPPPaaaaggggeeee 4444






RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))                                              RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))



     Store the vector of NNNN uuuunnnnssssiiiiggggnnnneeeedddd cccchhhhaaaarrrrs starting at pppp to the output stream.
     The chars should be treated as literal numbers (i.e., not as a character
     string).

              virtual RWvostream&
          ppppuuuutttt(const short* p, size_t N) = 0;


     Store the vector of NNNN sssshhhhoooorrrrtttts starting at pppp to the output stream.

              virtual RWvostream&
          ppppuuuutttt(const unsigned short* p, size_t N) = 0;


     Store the vector of NNNN uuuunnnnssssiiiiggggnnnneeeedddd sssshhhhoooorrrrtttts starting at pppp to the output stream.

              virtual RWvostream&
          ppppuuuutttt(const int* p, size_t N) = 0;


     Store the vector of NNNN iiiinnnntttts starting at pppp to the output stream.

              virtual RWvostream&
          ppppuuuutttt(const unsigned int* p, size_t N) = 0;


     Store the vector of NNNN uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttts starting at pppp to the output stream.

              virtual RWvostream&
          ppppuuuutttt(const long* p, size_t N) = 0;


     Store the vector of NNNN lllloooonnnnggggs starting at pppp to the output stream.

              virtual RWvostream&
          ppppuuuutttt(const unsigned long* p, size_t N) = 0;


     Store the vector of NNNN uuuunnnnssssiiiiggggnnnneeeedddd lllloooonnnnggggs starting at pppp to the output stream.

              virtual RWvostream&
          ppppuuuutttt(const float* p, size_t N) = 0;


     Store the vector of NNNN ffffllllooooaaaatttts starting at pppp to the output stream.

              virtual RWvostream&
          ppppuuuutttt(const double* p, size_t N) = 0;


     Store the vector of NNNN ddddoooouuuubbbblllleeees starting at pppp to the output stream.




                                                                        PPPPaaaaggggeeee 5555






RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))                                              RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))



              virtual RWvostream&
          ppppuuuuttttSSSSttttrrrriiiinnnngggg(const char*s, size_t N);


     Store the character string, iiiinnnncccclllluuuuddddiiiinnnngggg eeeemmmmbbbbeeeeddddddddeeeedddd nnnnuuuullllllllssss, starting at s to
     the output string.

















































                                                                        PPPPaaaaggggeeee 6666